home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / perl5 / Pod::Html.z / Pod::Html
Encoding:
Text File  |  1998-10-30  |  4.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))                                                      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      Pod::HTML - module to convert pod files to HTML
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.          use Pod::HTML;
  13.          pod2html([options]);
  14.  
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      Converts files from pod format (see the _p_e_r_l_p_o_d manpage) to HTML format.
  18.      It can automatically generate indexes and cross-references, and it keeps
  19.      a cache of things it knows how to cross-reference.
  20.  
  21. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  22.      Pod::Html takes the following arguments:
  23.  
  24.      help
  25.  
  26.              --help
  27.  
  28.          Displays the usage message.
  29.  
  30.      htmlroot
  31.  
  32.              --htmlroot=name
  33.  
  34.          Sets the base URL for the HTML files.  When cross-references are
  35.          made, the HTML root is prepended to the URL.
  36.  
  37.      infile
  38.  
  39.              --infile=name
  40.  
  41.          Specify the pod file to convert.  Input is taken from STDIN if no
  42.          infile is specified.
  43.  
  44.      outfile
  45.  
  46.              --outfile=name
  47.  
  48.          Specify the HTML file to create.  Output goes to STDOUT if no outfile
  49.          is specified.
  50.  
  51.      podroot
  52.  
  53.              --podroot=name
  54.  
  55.          Specify the base directory for finding library pods.
  56.  
  57.      podpath
  58.  
  59.              --podpath=name:...:name
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))                                                      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  71.  
  72.  
  73.  
  74.          Specify which subdirectories of the podroot contain pod files whose
  75.          HTML converted forms can be linked-to in cross-references.
  76.  
  77.      libpods
  78.  
  79.              --libpods=name:...:name
  80.  
  81.          List of page names (eg, "perlfunc") which contain linkable =items.
  82.  
  83.      netscape
  84.  
  85.              --netscape
  86.  
  87.          Use Netscape HTML directives when applicable.
  88.  
  89.      nonetscape
  90.  
  91.              --nonetscape
  92.  
  93.          Do not use Netscape HTML directives (default).
  94.  
  95.      index
  96.  
  97.              --index
  98.  
  99.          Generate an index at the top of the HTML file (default behaviour).
  100.  
  101.      noindex
  102.  
  103.              --noindex
  104.  
  105.          Do not generate an index at the top of the HTML file.
  106.  
  107.      recurse
  108.  
  109.              --recurse
  110.  
  111.          Recurse into subdirectories specified in podpath (default behaviour).
  112.  
  113.      norecurse
  114.  
  115.              --norecurse
  116.  
  117.          Do not recurse into subdirectories specified in podpath.
  118.  
  119.      title
  120.  
  121.              --title=title
  122.  
  123.          Specify the title of the resulting HTML file.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))                                                      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  137.  
  138.  
  139.  
  140.      verbose
  141.  
  142.              --verbose
  143.  
  144.          Display progress messages.
  145.  
  146. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  147.          pod2html("pod2html",
  148.                   "--podpath=lib:ext:pod:vms",
  149.                   "--podroot=/usr/src/perl",
  150.                   "--htmlroot=/perl/nmanual",
  151.                   "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
  152.                   "--recurse",
  153.                   "--infile=foo.pod",
  154.                   "--outfile=/perl/nmanual/foo.html");
  155.  
  156.  
  157. AAAAUUUUTTTTHHHHOOOORRRR
  158.      Tom Christiansen, <tchrist@perl.com>.
  159.  
  160. BBBBUUUUGGGGSSSS
  161.      Has trouble with  etc in = commands.
  162.  
  163. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  164.      the _p_e_r_l_p_o_d manpage
  165.  
  166. CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  167.      This program is distributed under the Artistic License.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))                                                      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.